home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / gt1700_6.zip / PCKERMIT.TXT < prev    next >
Text File  |  1986-08-23  |  22KB  |  521 lines
  1. PCKERMIT.HLP                                            Jan. 16, 1985
  2.  
  3. PC-DOS Kermit with Sliding Windows                      Rev 1.18
  4. ----------------------------------                      12/10/85
  5.  
  6. PCKERMIT.EXE USER GUIDE
  7. =======================
  8.  
  9. Introduction
  10. ------------
  11.  
  12. PCKERMIT version 1.18 is the first implementation of the "Sliding Window
  13. Extension" to Kermit (the extension is popularly called SuperKermit).  This
  14. extension allows data packets to be sent continuosly under most conditions,
  15. unlike "Kermit Classic" or XMODEM, both of which must wait for the other
  16. side to return an acknowledgment after each data packet has been sent.
  17.  
  18. This continuous transmission of data is especially helpful when there are
  19. delays in the communications path, such as via satelite transmission or
  20. over the public data networks (Telenet, Uninet, Tymnet, etc).
  21.  
  22.  
  23. NOT A TERMINAL PROGRAM
  24. ----------------------
  25.  
  26. PCKERMIT.EXE is not a terminal program.  It simply implements the Kermit
  27. protocol, including the sliding window extension.  It will work with
  28. older "Kermit Classic" implemenations as well, via automatic negotiation
  29. between the two Kermit programs.
  30.  
  31. PCKERMIT.EXE runs as a "one-shot" execution then returns to the caller.  A
  32. single file or multiple files (wildcard filename) are transferred until
  33. execution is completed or the transfer is abnormally aborted.  If execution
  34. is performed by the user from the DOS command line, termination of PCKERMIT
  35. returns control to PC-DOS.
  36.  
  37.  
  38. USE OF PCKERMIT.EXE
  39. -------------------
  40.  
  41. PCKERMIT does not establish a carrier with a remote system.  The connection
  42. must be established using a separate terminal program, and the remote
  43. Kermit selected using the separate terminal program.
  44.  
  45. Then you return to the MSDOS prompt and start PCKERMIT for the actual file
  46. transfer.
  47.  
  48. Here is a sample transfer taken from my screen, receiving a file using
  49. parity of mark.  (The file was being sent from The Source.)
  50.  
  51. ---------------Start of example------------------
  52.  
  53. {On The Source}
  54.  
  55. -> kermit -s l-steve.txt               {send me the file "l-steve.txt"}
  56. Kermit send started
  57.  
  58. {Exit from my terminal package to MS-DOS}
  59.  
  60. A:\>PCKERMIT -P M -R
  61. NSF
  62. L-STEVE.TXT => L-STEVE.TXT
  63. CTRL-F to cancel File,  CTRL-R to Resend current packet
  64. CTRL-B to cancel Batch, CTRL-K to abort Kermit and exit
  65. CTRL-A for status report: A
  66. File creation date: 12/18/85 - 14:17:16
  67.  
  68. File size (bytes): 1132
  69. ....Z [OK]B                            {Dots .... are put up for every 4th
  70.                                         packet received.  Z indicates the
  71.                                         end-of-file packet.  [OK] means the
  72.                                         file was received and written to
  73.                                         disk OK.  B indicates the end-of-
  74.                                         batch packet, the conclusion of the
  75.                                         transfer}
  76.  
  77. A:\>                                   {Back to MSDOS}
  78.  
  79. {Start my terminal program again}
  80.  
  81.  
  82. ---------------End of example--------------------
  83.  
  84.  
  85. The command syntax of the stand-alone Kermit program is shown in Figure 1.
  86. Here are examples of execution from the DOS command line:
  87.  
  88. PCKERMIT
  89.    or
  90. PCKERMIT -H               Help: Will give you the screen of figure 1 below
  91.  
  92. PCKERMIT -R               Receive: Will receive a file using the PCKERMIT
  93.                           defaults of 1200 baud, parity none, on COM1.
  94.  
  95. PCKERMIT -S FILENAME.EXT  Send: Will send a file using the PCKERMIT
  96.                           defaults of 1200 baud, parity none, on COM1.
  97.  
  98.  
  99. PCKERMIT -R -P M          Receive: Will receive a file using Parity Mark
  100.  
  101.  
  102. PCKERMIT -L COM2 -B 2400 -P M -R
  103.  
  104.                           This will use serial line COM2 at 2400 baud and
  105.                           parity of mark to receive a file.
  106.  
  107. Upper or lower case does not matter; neither does the order of the options
  108. (i.e., PCKERMIT -R -P M  will do the same thing as PCKERMIT -P M -R)
  109.  
  110.  
  111.  
  112. --------------Start of Figure 1-------------------------------------------
  113.  
  114. Figure 1. PCKERMIT command syntax.
  115.  
  116.   PCKERMIT version 1.18, December 10, 1985
  117.   Usage: PCKERMIT [-x arg [-x arg]...[-yyy]..]]
  118.   x is an option that requires an argument, y an option with no argument:
  119.      -s file(s)   send
  120.      -r           receive
  121.      -a name      alternate name, used with -s, -r
  122.      -h           help - print this message
  123.   settings --                                                        default
  124.      -l line      communication line device ( COM1, COM2 )            [COM1]
  125.      -b baud      line speed, e.g. 1200                               [1200]
  126.      -p x         parity, x is one of e,o,m,s,n                        [N]
  127.      -m size      maximum window size to use ( <= 31 )                 [31]
  128.      -n           non binary file transfer, affect CR/LF
  129.      -t           line turnaround handshake = xon, half duplex
  130.      -w           write over preexisting files
  131.      -q           be quiet during file transfer
  132.      -c           carrier detect signal required to be present
  133.  
  134.  
  135. Note 1:  If -t is used, -m should not be used.
  136.  
  137. Note 2:  The usage of -w is reversed from standard Columbia CKERMIT.
  138.  
  139.  
  140. --------------End of Figure 1---------------------------------------------
  141.  
  142.  
  143.  
  144. USE OF BATCH FILES
  145. ------------------
  146.  
  147. Two small batch files can greatly simplify use of PCKERMIT:
  148.  
  149.  
  150. SEND.BAT would look like this using Mark parity at 1200 baud on COM1:
  151.  
  152. PCKERMIT -P M -S %1
  153.  
  154.  
  155. REC.BAT would look like this using Mark parity at 1200 baud on COM1:
  156.  
  157. PCKERMIT -P M -R
  158.  
  159. This makes it easy to send a file by just typing
  160.  
  161. SEND filename.ext
  162.  
  163. and receive a file by typing
  164.  
  165. REC
  166.  
  167. at the MSDOS prompt.  Change the PCKERMIT command line to reflect your
  168. communications setup (add -B 300 for 300 baud, etc.).
  169.  
  170. You could include the name of your terminal software at the end of the
  171. batch file so you went directly back to your terminal software when
  172. finished with the transfer.
  173.  
  174.  
  175. CHARACTERS DISPLAYED DURING TRANSFER
  176. ------------------------------------
  177.  
  178. During operation of the standalone PCKERMIT it
  179. may display the following:
  180.  
  181.     %   Resend of last packet
  182.     .   Is printed every FOURTH data packet
  183.     A   Attributes packet (file length and creation date)
  184.     B   End of transmission packet
  185.     F   File Header
  186.     N   NAK packet
  187.     Q   Bad checksum or other packet error
  188.     S   Send-Init packet
  189.     T   Timeout
  190.     Z   End of file packet
  191.  
  192.  
  193. KEYBOARD INTERRUPTS
  194. -------------------
  195.  
  196. During a file transfer PCKERMIT responds (sometimes slowly) to
  197. the following keystrokes:
  198.  
  199. CTRL-F to cancel File,  CTRL-R to Resend current packet .
  200. CTRL-B to cancel Batch, CTRL-K to abort Kermit and exit
  201. CTRL-A for status report:
  202.  
  203. These functions are available even at the start of PCKERMIT before it
  204. tells you they are available.  In particular, Control-K can be used if
  205. the "Send-Init" exchange does not seem to be working.
  206.  
  207. Please note that PCKERMIT checks the keyboard infrequently under some
  208. conditions.  WAIT at least 20 - 30 seconds before repeating a keystroke
  209. in order to avoid stacking up repeated commands.  This is particularly true
  210. of CTRL-F (cancel file) where you might cancel more than one file.
  211.  
  212. Also, the Control-F and Control-B (cancel file and cancel batch) functions
  213. sometimes require a NAK and a resend or a timeout before they actually
  214. work.  This is not a protocol problem, but is due to the way PCKERMIT
  215. flushes it buffer before sending the abort packet.  In some cases, the
  216. flushing of the buffer truncates a packet and the following abort packet is
  217. not seen as a separate packet.
  218.  
  219. Here is a more detailed explanation of the functions:
  220.  
  221.   CTRL-F will cancel an individual file in a wildcard transaction,
  222.   but then continue with the next file in the batch.
  223.  
  224.   CTRL-B will cancel the entire batch of files, according to
  225.   protocol, and then return you to the DOS prompt.
  226.  
  227.   CTRL-K will abort the file transfer and return you to the DOS
  228.   prompt.  PCKERMIT sends an Error packet indicating it is
  229.   aborting, but otherwise